Mailing (API de Notificación de Errores)

Introducción

La API de Notificación de Errores permite a los desarrolladores enviar notificaciones de errores a través de correo electrónico para el seguimiento y la resolución de problemas en aplicaciones.

URL Base

• https://inmersys-mailing-microservices.glitch.me/api

Endpoint

POST /email/notify

Este endpoint se utiliza para enviar notificaciones de errores por correo electrónico.

Parámetros de la Solicitud

Nombre	Lugar en la Petición	Tipo	Descripción
subject	Body - JSON	String	Asunto del correo electrónico.
project	Body - JSON	String	Nombre del proyecto asociado al error.
messageError	Body - JSON	String	Mensaje detallado del error.
routeError	Body - JSON	String	Ruta donde ocurrió el error en la aplicación.

Ejemplo de Solicitud

{
  "subject": "test Error servidor 001",
  "project": "Proyecto inmersys 001", 
  "messageError": "Error details here",
  "routeError": "/home/auth/sing"
}

Ejemplo de Código (Node.js)

const axios = require("axios");

// Configuración de la instancia de Axios para la API de Notificación de Errores
const mailErrorInstance = axios.create({ baseURL: "https://inmersys-mailing-microservices.glitch.me/api" });

// Función para enviar errores
const sendError = async ({
    subject,
    messageError,
    project,
    routeError,
}) => {
    await mailErrorInstance.post("/email/notify", { subject, messageError, project, routeError });
};

// Uso del código
const errorData = {
    subject: "test Error servidor 001",
    project: "Proyecto inmersys 001", 
    messageError: "Error details here",
    routeError: "/home/auth/sing"
};

sendError(errorData);

Respuestas

Códigos de Estado HTTP

• 200 OK: La notificación de error se ha enviado correctamente.
• 400 Bad Request: Error en la solicitud. Se proporciona información adicional en el cuerpo de la respuesta.
• 500 Internal Server Error: Error interno en el servidor al procesar la notificación.

Ejemplo de Respuesta Exitosa

{
  "status": "success",
  "message": "Notificación de error enviada con éxito."
}

Ejemplo de Respuesta de Error

{
  "status": "error",
  "message": "Error al procesar la notificación. Verifique los datos proporcionados."
}

Consideraciones Importantes

• Asegúrese de proporcionar todos los parámetros requeridos en la solicitud.
• Verifique el formato de los datos antes de realizar la solicitud.
• En caso de problemas, comuníquese con el soporte técnico.

Contacto

Para asistencia adicional, comuníquese con el equipo de soporte técnico a través de support@inmersys.com.